Get list of winPolicy

GET /v1/organizations/:organizationId/mdm/windows/enterprise/policies/

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Entity Id or Slug

Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

page integer

optional

Page number

limit integer

optional

Number of elements by page

sort string

optional

Match pattern: ^[\w.]*((:asc)|(:desc))?$

name string

optional

≤ 256 characters

targetType string

optional

device

Responses

200 Response application/json

status boolean optional

data object optional

items array [object] optional

id string optional

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

organizationId string optional

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

winEnterpriseId string optional

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

name string optional

≤ 256 characters

config object optional

applications array [object] optional

winApplicationId string optional

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

configuration object optional

action string optional

≤ 128 characters

forceInstall available

applicationsInfo array [object] optional

scripts array [object] optional

type string optional

once loop onDemand

id string optional

≤ 128 characters

loopTime integer optional

≥ 0

resetDate string optional

Format: date-time

arguments string optional

argumentsProcessed string optional

name string optional

≤ 256 characters

description string optional

≤ 500 characters

runner string optional

≤ 256 characters

scriptsInfo array [object] optional

admxConfigs array [object] optional

winAdmxConfigId string optional

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

admxConfigsInfo array [object] optional

id string optional

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

appName string optional

≤ 256 characters

settingType string optional

≤ 256 characters

fileName string optional

≤ 256 characters

description string optional

≤ 256 characters

agentConfiguration object optional

enabled boolean optional

buildTag string optional

≤ 128 characters

allowLocation boolean optional

allowNetworkStatus boolean optional

allowPackageTime boolean optional

allowPackageTransfer boolean optional

assets array [object] optional

mdmAssetId string optional

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

location string optional

≤ 256 characters

assetName string optional

≤ 256 characters

scope string optional

user system all-users

assetsInfo array [object] optional

version integer optional

≥ 0

updatedAt string optional

Format: date-time

createdAt string optional

Format: date-time

totalDocs integer optional

limit integer optional

hasPrevPage boolean optional

hasNextPage boolean optional

page integer optional

totalPages integer optional

prevPage integer optional

nextPage integer optional

lean boolean optional

{
    "status": true,
    "data": {
        "items": [
            {
                "id": "string",
                "organizationId": "string",
                "winEnterpriseId": "string",
                "name": "string",
                "config": {},
                "applications": [
                    {
                        "winApplicationId": "string",
                        "configuration": {},
                        "action": "forceInstall"
                    }
                ],
                "applicationsInfo": [
                    {}
                ],
                "scripts": [
                    {
                        "type": "once",
                        "id": "string",
                        "loopTime": 0,
                        "resetDate": "2024-01-01T00: 00:00Z",
                        "arguments": "string",
                        "argumentsProcessed": "string",
                        "name": "string",
                        "description": "string",
                        "runner": "string"
                    }
                ],
                "scriptsInfo": [
                    {}
                ],
                "admxConfigs": [
                    {
                        "winAdmxConfigId": "string"
                    }
                ],
                "admxConfigsInfo": [
                    {
                        "id": "string",
                        "appName": "string",
                        "settingType": "string",
                        "fileName": "string",
                        "description": "string"
                    }
                ],
                "agentConfiguration": {
                    "enabled": true,
                    "buildTag": "string",
                    "allowLocation": true,
                    "allowNetworkStatus": true,
                    "allowPackageTime": true,
                    "allowPackageTransfer": true
                },
                "assets": [
                    {
                        "mdmAssetId": "string",
                        "location": "string",
                        "assetName": "string",
                        "scope": "user"
                    }
                ],
                "assetsInfo": [
                    {}
                ],
                "version": 0,
                "updatedAt": "2024-01-01T00: 00:00Z",
                "createdAt": "2024-01-01T00: 00:00Z"
            }
        ],
        "totalDocs": 0,
        "limit": 0,
        "hasPrevPage": true,
        "hasNextPage": true,
        "page": 0,
        "totalPages": 0,
        "prevPage": 0,
        "nextPage": 0,
        "lean": true
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4004

message string optional

Invalid Token

{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}

404 Response application/json

status boolean optional

false

error object optional

code number optional

3001

message string optional

Entity not found

{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}